/*! \file bcmdrd_sym_ser.c
 *
 * BCMDRD routines related to SER.
 */
/*
 * Copyright: (c) 2018 Broadcom. All Rights Reserved. "Broadcom" refers to 
 * Broadcom Limited and/or its subsidiaries.
 * 
 * Broadcom Switch Software License
 * 
 * This license governs the use of the accompanying Broadcom software. Your 
 * use of the software indicates your acceptance of the terms and conditions 
 * of this license. If you do not agree to the terms and conditions of this 
 * license, do not use the software.
 * 1. Definitions
 *    "Licensor" means any person or entity that distributes its Work.
 *    "Software" means the original work of authorship made available under 
 *    this license.
 *    "Work" means the Software and any additions to or derivative works of 
 *    the Software that are made available under this license.
 *    The terms "reproduce," "reproduction," "derivative works," and 
 *    "distribution" have the meaning as provided under U.S. copyright law.
 *    Works, including the Software, are "made available" under this license 
 *    by including in or with the Work either (a) a copyright notice 
 *    referencing the applicability of this license to the Work, or (b) a copy 
 *    of this license.
 * 2. Grant of Copyright License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    copyright license to reproduce, prepare derivative works of, publicly 
 *    display, publicly perform, sublicense and distribute its Work and any 
 *    resulting derivative works in any form.
 * 3. Grant of Patent License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    patent license to make, have made, use, offer to sell, sell, import, and 
 *    otherwise transfer its Work, in whole or in part. This patent license 
 *    applies only to the patent claims licensable by Licensor that would be 
 *    infringed by Licensor's Work (or portion thereof) individually and 
 *    excluding any combinations with any other materials or technology.
 *    If you institute patent litigation against any Licensor (including a 
 *    cross-claim or counterclaim in a lawsuit) to enforce any patents that 
 *    you allege are infringed by any Work, then your patent license from such 
 *    Licensor to the Work shall terminate as of the date such litigation is 
 *    filed.
 * 4. Redistribution
 *    You may reproduce or distribute the Work only if (a) you do so under 
 *    this License, (b) you include a complete copy of this License with your 
 *    distribution, and (c) you retain without modification any copyright, 
 *    patent, trademark, or attribution notices that are present in the Work.
 * 5. Derivative Works
 *    You may specify that additional or different terms apply to the use, 
 *    reproduction, and distribution of your derivative works of the Work 
 *    ("Your Terms") only if (a) Your Terms provide that the limitations of 
 *    Section 7 apply to your derivative works, and (b) you identify the 
 *    specific derivative works that are subject to Your Terms. 
 *    Notwithstanding Your Terms, this license (including the redistribution 
 *    requirements in Section 4) will continue to apply to the Work itself.
 * 6. Trademarks
 *    This license does not grant any rights to use any Licensor's or its 
 *    affiliates' names, logos, or trademarks, except as necessary to 
 *    reproduce the notices described in this license.
 * 7. Limitations
 *    Platform. The Work and any derivative works thereof may only be used, or 
 *    intended for use, with a Broadcom switch integrated circuit.
 *    No Reverse Engineering. You will not use the Work to disassemble, 
 *    reverse engineer, decompile, or attempt to ascertain the underlying 
 *    technology of a Broadcom switch integrated circuit.
 * 8. Termination
 *    If you violate any term of this license, then your rights under this 
 *    license (including the license grants of Sections 2 and 3) will 
 *    terminate immediately.
 * 9. Disclaimer of Warranty
 *    THE WORK IS PROVIDED "AS IS" WITHOUT WARRANTIES OR CONDITIONS OF ANY 
 *    KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WARRANTIES OR CONDITIONS OF 
 *    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR 
 *    NON-INFRINGEMENT. YOU BEAR THE RISK OF UNDERTAKING ANY ACTIVITIES UNDER 
 *    THIS LICENSE. SOME STATES' CONSUMER LAWS DO NOT ALLOW EXCLUSION OF AN 
 *    IMPLIED WARRANTY, SO THIS DISCLAIMER MAY NOT APPLY TO YOU.
 * 10. Limitation of Liability
 *    EXCEPT AS PROHIBITED BY APPLICABLE LAW, IN NO EVENT AND UNDER NO LEGAL 
 *    THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE 
 *    SHALL ANY LICENSOR BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, 
 *    INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF 
 *    OR RELATED TO THIS LICENSE, THE USE OR INABILITY TO USE THE WORK 
 *    (INCLUDING BUT NOT LIMITED TO LOSS OF GOODWILL, BUSINESS INTERRUPTION, 
 *    LOST PROFITS OR DATA, COMPUTER FAILURE OR MALFUNCTION, OR ANY OTHER 
 *    COMMERCIAL DAMAGES OR LOSSES), EVEN IF THE LICENSOR HAS BEEN ADVISED OF 
 *    THE POSSIBILITY OF SUCH DAMAGES.
 */

#include <bsl/bsl.h>

#include <sal/sal_assert.h>
#include <sal/sal_libc.h>

#include <bcmdrd/bcmdrd_symbols.h>
#include <bcmdrd/bcmdrd_ser.h>

#if BCMDRD_CONFIG_INCLUDE_CHIP_SYMBOLS == 1

const void *
bcmdrd_sym_ser_data_get(const bcmdrd_symbols_t *symbols)
{
    if (symbols == NULL) {
        return NULL;
    }
    return symbols->ser_data;
}

int
bcmdrd_sym_ser_profile_offset_get(const bcmdrd_symbol_t *symbol)
{
    if (symbol == NULL) {
        return -1;
    }
    return BCMDRD_SYM_EP_OFFSET_GET(symbol->pfinfo);
}

static const uint32_t *
ser_profile_get(const bcmdrd_ser_data_t *ser_data, int sympf_offset)
{
    const uint32_t *prfs;

    /* Offset 0 is reserved for symbols without SER defined. */
    if (ser_data == NULL || sympf_offset <= 0) {
        return NULL;
    }

    /* Get the ser array of the whole symbols. */
    prfs = ser_data->sym_profiles;;
    if (prfs == NULL) {
        return NULL;
    }

    return prfs + sympf_offset;
}

const uint32_t *
bcmdrd_sym_ser_info_profile_get(const bcmdrd_ser_data_t *ser_data,
                                int sympf_offset)
{
    const uint32_t *info_pfs;
    const uint32_t *sym_pf;
    int offset;

    sym_pf = ser_profile_get(ser_data, sympf_offset);
    if (sym_pf == NULL) {
        return NULL;
    }
    /* Get the offset in SER information profiles. */
    offset = BCMDRD_SER_PF_INFO_GET(*sym_pf);

    /* Get SER information profiles */
    info_pfs = ser_data->info_profiles;
    if (info_pfs == NULL) {
        return NULL;
    }

    return info_pfs + offset;
}

const uint32_t *
bcmdrd_sym_ser_en_ctrl_profile_get(const bcmdrd_ser_data_t *ser_data,
                                   int sympf_offset,
                                   bcmdrd_ser_en_type_t type)
{
    const uint32_t *en_pfs;
    const uint32_t *sym_pf;
    int offset = -1;
    uint32_t enctrl;

    sym_pf = ser_profile_get(ser_data, sympf_offset);
    if (sym_pf == NULL) {
        return NULL;
    }

    if (type >= BCMDRD_SER_EN_TYPE_MAX) {
        return NULL;
    }

    /* Get enable control profiles for the given type. */
    en_pfs = ser_data->en_profiles[type];
    if (en_pfs == NULL) {
        return NULL;
    }

    /*
     * Check whether the specified SER enable type profile is
     * encoded for this symbol.
     */
    do {
        if (BCMDRD_SER_PF_ENCTRL0(*sym_pf)) {
            enctrl = BCMDRD_SER_PF_ENCTRL0_GET(*sym_pf);
            if (BCMDRD_SER_PF_ENCTRL_TYPE_GET(enctrl) == type) {
                offset = BCMDRD_SER_PF_ENCTRL_IDX_GET(enctrl);
                break;
            }
        }
        if (BCMDRD_SER_PF_ENCTRL1(*sym_pf)) {
            enctrl = BCMDRD_SER_PF_ENCTRL1_GET(*sym_pf);
            if (BCMDRD_SER_PF_ENCTRL_TYPE_GET(enctrl) == type) {
                offset = BCMDRD_SER_PF_ENCTRL_IDX_GET(enctrl);
                break;
            }
        }
    } while (!BCMDRD_SER_PF_LAST(*sym_pf++));

    return (offset < 0) ? NULL : en_pfs + offset;
}

const bcmdrd_ser_rmr_t *
bcmdrd_sym_ser_rmr_get(const bcmdrd_ser_data_t *ser_data,
                       bcmdrd_ser_rmr_id_t rid)
{
    if (ser_data == NULL) {
        return NULL;
    }

    if (rid >= ser_data->rmrs_size) {
        return NULL;
    }

    return ser_data->rmrs + rid;
}

const bcmdrd_ser_rmr_t *
bcmdrd_ser_rmr_find(const char *name, const bcmdrd_ser_data_t *ser_data,
                    bcmdrd_ser_rmr_id_t *rid)
{
    const bcmdrd_ser_rmr_t *rmr;
    uint32_t idx;

    if (ser_data == NULL || ser_data->rmrs == NULL || name == NULL) {
        return NULL;
    }
    rmr = ser_data->rmrs;

    for (idx = 0; idx < ser_data->rmrs_size; idx++) {
        if (sal_strcmp(rmr->name, name) == 0) {
            break;
        }
        rmr++;
    }

    if (idx >= ser_data->rmrs_size) {
        rmr = NULL;
    } else if (rid) {
        *rid = idx;
    }
    return rmr;
}

int
bcmdrd_ser_rmr_profile_offset_get(const bcmdrd_ser_rmr_t *rmr)
{
    if (rmr == NULL) {
        return -1;
    }
    return BCMDRD_SER_RMR_EP_OFFSET_GET(rmr->pfinfo);
}

#endif /* BCMDRD_CONFIG_INCLUDE_CHIP_SYMBOLS */
